<?php
///////////////////////////////////////////////////////////////////////////////////////////////////////
//  这个文件是 JCAT PHP框架的一部，该项目和此文件 均遵循 GNU 自由软件协议
// 
//  Copyleft 2008 JeCat.cn(http://team.JeCat.cn)
//
//
//  JCAT PHP框架 的正式全名是：Jellicle Cat PHP Framework。
//  “Jellicle Cat”出自 Andrew Lloyd Webber的音乐剧《猫》（《Prologue:Jellicle Songs for Jellicle Cats》）。
//  JCAT 是一个开源项目，它像音乐剧中的猫一样自由，你可以毫无顾忌地使用JCAT PHP框架。
//  JCAT 由中国团队开发维护，是一个国际性的项目。
//  正在使用的这个版本是：0.3.1 / SVN信息：$Id: interface.JCAT_IDocument.php 1119 2008-10-25 03:55:26Z alee $
//
//
//
//  相关的链接：
//    [主页] http://jcat.JeCat.cn
//    [HTTP下载] http://jcat.JeCat.cn/download
//    [在线文档] http://jcat.JeCat.cn/document
//    [社区] http://jj.jecat.cn/forum-7-1.html
//  不很相关：
//    [MP3] http://www.google.cn/search?q=jellicle+songs+for+jellicle+cats+Andrew+Lloyd+Webber
//    [VCD/DVD] http://www.google.cn/search?q=CAT+Andrew+Lloyd+Webber+video
//
///////////////////////////////////////////////////////////////////////////////////////////////////////
/*-- Project Introduce --*/



JCAT_Package::ImportInterface('JCAT_IDocumentContainer',JCAT::PACKAGE_MVC) ;
JCAT_Package::ImportInterface('JCAT_IViewContainer',JCAT::PACKAGE_MVC) ;

/**
 * What's this Class ?
 *
 * @author		alee
 * @access		public
 */
interface JCAT_IDocument extends JCAT_IDocumentContainer, JCAT_IViewContainer
{
	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @return	string
	 */
	public function GetName(  )  ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @param	$sName	string	What's this Parameter ?
	 * @return	old_var
	 */
	public function SetName( $sName )  ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @param	$nType=self:Save	int	What's this Parameter ?
	 * @return	void
	 */
	public function Serialize( $nType=JCAT_Document::Save )  ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @return	void
	 */
	public function Load(  )  ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @return	void
	 */
	public function Save(  )  ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @return	void
	 */
	public function Create() ;
	
	
	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @return	void
	 */
	public function Delete() ;

	/**
	 * 文档是否存在
	 * 
	 * @access	public
	 * @param	$bRequery=false		bool	对于高级文档（如数据库文档），查询 文档是否存在 会存在一定性能代价 ，该参数允许缓存查询结果
	 * @return	bool
	 */
	public function IsExists( $bRequery=false ) ;
	
	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @param	$sDataName	string	What's this Parameter ?
	 * @return	
	 */
	public function Get( $sDataName )  ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @param	$sDataName			string	What's this Parameter ?
	 * @param	$Value				mixed	What's this Parameter ?
	 * @param	$bSetChanged=true	bool	What's this Parameter ?
	 * @return	
	 */
	public function Set( $sDataName, $Value, $bSetChanged=true )  ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @param	$bQueryChildren=true	bool
	 * @return	bool
	 */
	public function IsChanged( $bQueryChildren=true )   ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @param	$bChanged=true			bool	What's this Parameter ?
	 * @param	$bSetChildren=false		bool	What's this Parameter ?
	 * @return	old_var
	 */
	public function SetChanged( $bChanged=true, $bSetChildren=false )  ;



	/**
	 * What's this Method ?
	 * 
	 * @access	public
	 * @param	$aBut=null	JCAT_IView	What's this Parameter ?
	 * @return	void
	 */
	public function UpdateAllView( JCAT_IView $aBut=null )  ;

	
	/**
	 * 彻底 销毁一个文档 在  MVC 系统中的所有引用，以便在不需要该文档时能够立刻回收：
	 *  文档的全局名称上的引用
	 *  ... ...
	 * 
	 * @access	public
	 * @return	void
	 */
	public function Destroy() ;


	// 属性 ///////////////////////////////////////////////////////////////////////////////


}
?>